home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_mpg123.idb / usr / freeware / catman / u_man / cat1 / mpg123.Z / mpg123
Encoding:
Text File  |  1999-04-16  |  16.3 KB  |  397 lines

  1.  
  2.  
  3.  
  4.      mmmmppppgggg111122223333((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 AAAApppprrrr 1111999999997777))))         mmmmppppgggg111122223333((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       mpg123 - play    audio MPEG 1.0/2.0 file    (layers    1, 2 and 3)
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.       mmmmppppgggg111122223333 [ ----ttttssssccccvvvvqqqqyyyy00001111mmmm22224444    ] [ ----bbbb _s_i_z_e ] [    ----kkkk _n_u_m ] [ ----nnnn _n_u_m ] [
  13.       ----ffff _f_a_c_t_o_r ] [    ----rrrr _r_a_t_e    ] [ ----gggg _g_a_i_n ] [    ----aaaa _d_e_v ] [ ----oooo ssss    | ----oooo hhhh
  14.       | ----oooo llll ] [ ----dddd    _n ] [ ----hhhh _n ] [ ----pppp _p_r_o_x_y    ] [ ----@@@@ _f_i_l_e ] _f_i_l_e ...
  15.       | _U_R_L    ... | ----
  16.  
  17.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.       mmmmppppgggg111122223333 reads one or more _f_i_l_es (or standard input if ``-''
  19.       is specified)    or _U_R_Ls    and plays them on the audio device
  20.       (default) or outputs them to stdout.    _f_i_l_e/_U_R_L is assumed to
  21.       be an    MPEG-1/2 audio bit stream.
  22.  
  23.      OOOOPPPPTTTTIIIIOOOONNNNSSSS
  24.       mmmmppppgggg111122223333 options may be    either the traditional POSIX one
  25.       letter options, or the GNU style long    options.  POSIX    style
  26.       options start    with a single ``-'', while GNU long options
  27.       start    with ``--''.
  28.  
  29.       ----tttt, --------tttteeeesssstttt
  30.            Test mode.  The audio stream is decoded,    but no output
  31.            occurs.
  32.  
  33.       ----ssss, --------ssssttttddddoooouuuutttt
  34.            The decoded audio samples are written to    standard
  35.            output, instead of playing them through the audio
  36.            device.    This option must be used if your audio
  37.            hardware    is not supported by mmmmppppgggg111122223333.  The output    format
  38.            is raw (headerless) linear PCM audio data, 16 bit,
  39.            stereo, host byte order.
  40.  
  41.       ----cccc, --------cccchhhheeeecccckkkk
  42.            Check for filter    range violations, and report them for
  43.            each frame if any occur.
  44.  
  45.       ----vvvv, --------vvvveeeerrrrbbbboooosssseeee
  46.            Increase    the verbosity level.  For example, displays
  47.            the frame numbers during    decoding.
  48.  
  49.       ----qqqq, --------qqqquuuuiiiieeeetttt
  50.            Quiet.  Suppress    diagnostic messages.
  51.  
  52.       ----yyyy, --------rrrreeeessssyyyynnnncccc
  53.            Try to resync and continue decoding if an error occurs
  54.            in the input file.  Also    try to recover from certain
  55.            broken headers.    Useful if you have a broken MPEG file,
  56.            on which    mmmmppppgggg111122223333 normally    gives up saying    `Illegal
  57.            header'.     Be careful:  Broken locations in MPEG files
  58.            might cause sharp, loud pops or clicks, which might
  59.            damage your speakers if played too loud.
  60.  
  61.  
  62.  
  63.      Page 1                          (printed 3/2/99)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      mmmmppppgggg111122223333((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 AAAApppprrrr 1111999999997777))))         mmmmppppgggg111122223333((((1111))))
  71.  
  72.  
  73.  
  74.       ----0000, --------ssssiiiinnnngggglllleeee0000; ----1111,
  75.            Decode only channel 0 (left) or channel 1 (right),
  76.            respectively.  These options are    available for stereo
  77.            MPEG streams only.
  78.  
  79.       ----mmmm, --------ssssiiiinnnngggglllleeeemmmmiiiixxxx
  80.            Mix both    channels.  This    option is available for    stereo
  81.            MPEG layer-3 streams only.  It takes less CPU time than
  82.            full stereo decoding.
  83.  
  84.       ----2222, --------2222ttttoooo1111; ----4444,
  85.            Performs    a downsampling of ratio    2:1 (22    kHz) or    4:1
  86.            (11 kHz)    on the output stream, respectively. Saves some
  87.            CPU cycles, but at least    the 4:1    ratio sounds ugly.
  88.  
  89.       ----bbbb _s_i_z_e, --------bbbbuuuuffffffffeeeerrrr _s_i_z_e
  90.            Use an audio output buffer of _s_i_z_e Kbytes.  This    is
  91.            useful to bypass    short periods of heavy system
  92.            activity, which would normally cause the    audio output
  93.            to be interrupted. You should specify a buffer size of
  94.            at least    1024 (i.e. 1 Mb, which equals about 6 seconds
  95.            of audio    data) or more; less than about 300 does    not
  96.            make much sense.     The default is    0, which turns
  97.            buffering off.
  98.  
  99.       ----kkkk _n_u_m, --------sssskkkkiiiipppp _n_u_m
  100.            Skip first _n_u_m frames.  By default the decoding starts
  101.            at the first frame.
  102.  
  103.       ----nnnn _n_u_m, --------ffffrrrraaaammmmeeeessss _n_u_m
  104.            Decode only _n_u_m frames.    By default the complete    stream
  105.            is decoded.
  106.  
  107.       ----ffff _f_a_c_t_o_r, --------ssssccccaaaalllleeee _f_a_c_t_o_r
  108.            Change scale factor (default: 32768).
  109.  
  110.       ----rrrr _r_a_t_e, --------rrrraaaatttteeee _r_a_t_e
  111.            Set sample rate (default: automatic).  You don't    want
  112.            to change this.
  113.  
  114.       ----gggg _g_a_i_n, --------ggggaaaaiiiinnnn _g_a_i_n
  115.            Set audio hardware output gain (default:    don't change).
  116.  
  117.       ----aaaa _d_e_v, --------aaaauuuuddddiiiiooooddddeeeevvvviiiicccceeee    _d_e_v
  118.            Specify the audio device    to use.     The default is
  119.            system-dependent    (usually /dev/audio or /dev/dsp).  Use
  120.            this option if you have multiple    audio devices and the
  121.            default is not what you want.
  122.  
  123.       ----oooo ssss,    --------ssssppppeeeeaaaakkkkeeeerrrr
  124.            Direct audio output to the speaker.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                          (printed 3/2/99)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      mmmmppppgggg111122223333((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 AAAApppprrrr 1111999999997777))))         mmmmppppgggg111122223333((((1111))))
  137.  
  138.  
  139.  
  140.       ----oooo hhhh,    --------hhhheeeeaaaaddddpppphhhhoooonnnneeeessss
  141.            Direct audio output to the headphone connector.
  142.  
  143.       ----oooo llll,    --------lllliiiinnnneeeeoooouuuutttt
  144.            Direct audio output to the line-out connector.
  145.  
  146.       ----dddd _n,    --------ddddoooouuuubbbblllleeeessssppppeeeeeeeedddd _n
  147.            Only play every _n'th frame.  This will cause the    MPEG
  148.            stream to be played _n times faster, which can be    used
  149.            for special effects.  Can also be combined with the
  150.            --------hhhhaaaallllffffssssppppeeeeeeeedddd option to play 3 out    of 4 frames etc.
  151.            Don't expect great sound    quality    when using this
  152.            option.
  153.  
  154.       ----hhhh _n,    --------hhhhaaaallllffffssssppppeeeeeeeedddd _n
  155.            Play each frame _n times.     This will cause the MPEG
  156.            stream to be played at 1/n'_t_h speed (n times slower),
  157.            which can be used for special effects. Can also be
  158.            combined    with the --------ddddoooouuuubbbblllleeeessssppppeeeeeeeedddd option to double    every
  159.            third frame or things like that.     Don't expect great
  160.            sound quality when using    this option.
  161.  
  162.       ----pppp _U_R_L | nnnnoooonnnneeee, --------pppprrrrooooxxxxyyyy _U_R_L | nnnnoooonnnneeee
  163.            The specified _p_r_o_x_y will    be used    for HTTP requests.  It
  164.            should be specified as full URL
  165.            (``http://host.domain:port/''), but the ``http://''
  166.            prefix, the port    number and the trailing    slash are
  167.            optional    (the default port is 80).  Specifying nnnnoooonnnneeee
  168.            means not to use    any proxy, and to retrieve files
  169.            directly    from the respective servers.  See also the
  170.            ``HTTP SUPPORT''    section.
  171.  
  172.       ----@@@@ _f_i_l_e, --------lllliiiisssstttt _f_i_l_e
  173.            Read filenames and/or URLs of MPEG audio    streams    from
  174.            the specified _f_i_l_e in addition to the ones specified on
  175.            the command line    (if any).  Note    that _f_i_l_e can be
  176.            either an ordinary file,    a dash ``-'' to    indicate that
  177.            a list of filenames/URLs    is to be read from the
  178.            standard    input, or an URL pointing to a an appropriate
  179.            list file.  Note: only one ----@@@@ option can    be used    (if
  180.            more than one is    specified, only    the last one will be
  181.            recognized).
  182.  
  183.      OOOOPPPPEEEERRRRAAAANNNNDDDDSSSS
  184.       The following    operands are supported:
  185.  
  186.       _f_i_l_e(s) The path name(s) of one or more input    files.    They
  187.           must be valid    MPEG-1/2 audio layer-1,    -2 or -3 bit
  188.           streams.  If a dash ``-'' is specified, MPEG data
  189.           will be read from the    standard input.     Furthermore,
  190.           any name starting with ``http://'' is    recognized as
  191.           _U_R_L (see next    section).
  192.  
  193.  
  194.  
  195.      Page 3                          (printed 3/2/99)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      mmmmppppgggg111122223333((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 AAAApppprrrr 1111999999997777))))         mmmmppppgggg111122223333((((1111))))
  203.  
  204.  
  205.  
  206.      HHHHTTTTTTTTPPPP SSSSUUUUPPPPPPPPOOOORRRRTTTT
  207.       In addition to reading MPEG audio streams from ordinary
  208.       files    and from the standard input, mmmmppppgggg111122223333 supports retrieval
  209.       of MPEG audio    files via the HTTP protocol, which is used in
  210.       the World Wide Web (WWW).  Such files    are specified using a
  211.       so-called URL    (universal resource location), which starts
  212.       with ``http://''.  When a file with that prefix is
  213.       encountered, mmmmppppgggg111122223333 attempts to open an HTTP connection to
  214.       the server in    order to retrieve that file to decode and play
  215.       it.
  216.  
  217.       It is    often useful to    retrieve files through a WWW cache or
  218.       so-called proxy.  To accomplish this,    mmmmppppgggg111122223333 examines    the
  219.       environment for variables named MMMMPPPP3333____HHHHTTTTTTTTPPPP____PPPPRRRROOOOXXXXYYYY, hhhhttttttttpppp____pppprrrrooooxxxxyyyy
  220.       and HHHHTTTTTTTTPPPP____PPPPRRRROOOOXXXXYYYY, in this order.  The value of the first one
  221.       that is set will be used as proxy specification.  To
  222.       override this, you can use the ----pppp command line option    (see
  223.       the ``OPTIONS'' section).  Specifying    ----pppp nnnnoooonnnneeee    will enforce
  224.       contacting the server    directly without using any proxy, even
  225.       if one of the    above environment variables is set.
  226.  
  227.       Note that, in    order to play MPEG audio files from a WWW
  228.       server, it is    necessary that the connection to that server
  229.       is fast enough.  For example,    a 128 kbit/s MPEG file
  230.       requires the network connection to be    at least 128 kbit/s
  231.       (16 kbyte/s) plus protocol overhead.    If you suffer from
  232.       short    network    outages, you should try    the ----bbbb option (buffer)
  233.       to bypass such outages.  If your network connection is
  234.       generally not    fast enough to retrieve    MPEG audio files in
  235.       realtime, you    can first download the files to    your local
  236.       harddisk (e.g. using llllyyyynnnnxxxx(1))    and then play them from    there.
  237.  
  238.      IIIINNNNTTTTEEEERRRRRRRRUUUUPPPPTTTT
  239.       You can abort    mmmmppppgggg111122223333 at any time by pressing Ctrl-C.    If you
  240.       are playing multiple files, this will    stop the current file
  241.       and begin playing the    next one.  If you want to abort
  242.       playing immediately instead of skipping to the next file,
  243.       press    Ctrl-C twice in    short succession (within about one
  244.       second).
  245.  
  246.       Note that the    result of pressing Ctrl-C might    not be audible
  247.       immediately, due to audio data buffering in the audio
  248.       device.  This    delay is system    dependent, but it is usually
  249.       not more than    one or two seconds.
  250.  
  251.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  252.       llllyyyynnnnxxxx(1), ssssooooxxxx(1), iiiinnnnttttrrrroooo(1)
  253.  
  254.      NNNNOOOOTTTTEEEESSSS
  255.       MPEG audio decoding requires a good deal of CPU performance,
  256.       especially layer-3.  To decode it in realtime, you should
  257.       have at least    a Pentium, Alpha, SuperSparc or    equivalent
  258.  
  259.  
  260.  
  261.      Page 4                          (printed 3/2/99)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      mmmmppppgggg111122223333((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 AAAApppprrrr 1111999999997777))))         mmmmppppgggg111122223333((((1111))))
  269.  
  270.  
  271.  
  272.       processor.  You can also use the ----ssssiiiinnnngggglllleeeemmmmiiiixxxx option to    decode
  273.       mono only, which reduces the CPU load    somewhat for layer-3
  274.       streams.  See    also the ----2222 and    ----4444 options.
  275.  
  276.       If everything    else fails, use    the ----ssss option to decode    to
  277.       standard output, direct it into a file and then use an
  278.       appropriate utility to play that file.  You might have to
  279.       use a    tool such as ssssooooxxxx(1) to convert the output to an    audio
  280.       format suitable for your audio player.
  281.  
  282.       Also note that mmmmppppgggg111122223333    always generates 16 bit    stereo data
  283.       (if one of the ----ssssiiiinnnngggglllleeee* options is used, two identical
  284.       stereo channels are generated).  If your hardware requires
  285.       some other format, for example 8 bit mono, you also have to
  286.       use a    converter such as ssssooooxxxx(1).
  287.  
  288.       If your system is generally fast enough to decode in
  289.       realtime, but    there are sometimes periods of heavy system
  290.       load (such as    cronjobs, users    logging    in remotely, starting
  291.       of ``big'' programs etc.) causing the    audio output to    be
  292.       interrupted, then you    should use the ----bbbb option to use    a
  293.       buffer of at least 1000 Kbytes.
  294.  
  295.      BBBBUUUUGGGGSSSS
  296.       Known    bugs and limitations:
  297.            MPEG-2, Layer 1 and 2 not tested. May not work. (Layer
  298.            3 should    work.)
  299.            Free format streams are not supported.
  300.            Layer-1 support is not heavily tested.
  301.            No CRC error checking is    performed.
  302.            There is    currently no support for audio hardware    on DEC
  303.            Digital Unix, Ultrix and    IBM AIX, therefore the ----ssss
  304.            option has to be    used on    those platforms.
  305.  
  306.      AAAAUUUUTTTTHHHHOOOORRRRSSSS
  307.       Main author:
  308.            Michael Hipp <Michael.Hipp@student.uni-tuebingen.de>
  309.  
  310.       Uses code (or    at least ideas)    from:
  311.            MPEG Software Simulation    Group (Base package)
  312.            Philipp Knirsch <phil@mpik-tueb.mpg.de> (DCT36/manual
  313.            unroll)
  314.            Tobias Bading <bading@cs.tu-berlin.de> (subband
  315.            synthesis)
  316.            Jeff Tsay <ctsay@pasteur.eecs.berkeley.edu> (DCT36)
  317.            Thomas Woerner (SGI Audio)
  318.            Damien Clermonte    <clermond@esiee.fr> (HP-UX audio
  319.            fixes)
  320.            Oliver Fromme <oliver.fromme@heim3.tu-clausthal.de>
  321.  
  322.       Internet references:
  323.       http://www.sfs.nphil.uni-tuebingen.de/~hipp/mpg123.html
  324.  
  325.  
  326.  
  327.      Page 5                          (printed 3/2/99)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      mmmmppppgggg111122223333((((1111))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((22221111 AAAApppprrrr 1111999999997777))))         mmmmppppgggg111122223333((((1111))))
  335.  
  336.  
  337.  
  338.       http://www.heim3.tu-clausthal.de/~olli/mpg123/
  339.       (includes information    about the mpg123 mailing list)
  340.  
  341.       The latest version is    also available from here:
  342.       ftp.tu-clausthal.de:/pub/unix/audio/mpg123
  343.       http://ftp.tu-clausthal.de/pub/unix/audio/mpg123
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.      Page 6                          (printed 3/2/99)
  394.  
  395.  
  396.  
  397.